Docs: update outdated guide to make code open by default#26872
Merged
Conversation
For storybook 7 or higher, the code below does not work.
```js
export const parameters = {
docs: {
source: {
state: 'open',
},
},
};
```
It should be fixed like below:
```js
export const parameters = {
docs: {
canvas: {
sourceState: 'shown'
}
}
};
```
However, this document seems not changed so far. So I updated it.
## References:
- https://storybook.js.org/docs/api/doc-block-canvas#sourcestate
- storybookjs#10430
jonniebigodes
added
ci:docs
jonniebigodes
changed the title
☁️ Nx Cloud ReportCI is running/has finished running commands for commit eafbe7e. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
jonniebigodes
approved these changes
May 14, 2024
jonniebigodes
left a comment
jonniebigodes
left a comment
Contributor
There was a problem hiding this comment.
@abiriadev thanks for taking the time to put together this pull request and helping us improve the documentation with this small but important misconfiguration. We appreciate it 🙏 !
I've checked and all is good on my end. Going to merge this once the checklist clears.
Hope you have a great day.
Stay safe
Contributor
|
Self merging this. |
17 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What I did
For storybook 7 or higher, the code below does not work.
It should be fixed like below:
However, this document seems not changed so far. So I updated it.
References:
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This is a document change, no testing is required.
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.